home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Software Vault: The Gold Collection
/
Software Vault - The Gold Collection (American Databankers) (1993).ISO
/
cdr25
/
isp3009b.zip
/
README1.DOC
< prev
next >
Wrap
Text File
|
1993-03-04
|
11KB
|
212 lines
==============================================================================
readme1.doc Ispell, International version 3.0.09(beta) 9/8/92
==============================================================================
This is port of the popular spelling program Ispell, international version
3.0.09(beta), written by Goeff Kuenning and Pace Willisson (with contributions
from many others).
This version is sort of a double beta version, as the version of Ispell which
I have ported is a beta, and this is the first release of the OS/2 port.
Please read completely through this file and consult any other readme?.doc
files in the distribution.
***** THIS PORT OF ISPELL REQUIRES OS/2 2.0 *****
***** INSTALLATION *****
Basically, the installation consists of the following steps:
1) unpack the archive
2) move emx.dll and termcap.dat to suitable directories
3) set some environment variables for termcap
4) build the hashed dictionaries from the included word lists.
5) edit ispell.cfg and modify the settings for your system.
These steps are explained in detail below.
* Unpack the archive *
If you are reading this document, you've succeeded at unpacking the archive.
Ispell does not need to have its own directory, but you may find that to be
more convenient. The archive contains no directory structure, so all the files
will be unpacked to the current directory. The files ispell.exe and
ispell.cfg MUST remain in the same directory. The program determines the path
of ispell.exe and looks for ispell.cfg in this directory. You can rename
ispell.exe, but you must also rename the base part of the configuration
filename to match the base part to the executable filename. For example, if
you rename ispell.exe to myspell.exe, you must also rename ispell.cfg to
myspell.cfg.
* emx.dll *
Ispell was ported using the emx/gcc environment. Therefore Ispell requires the
file emx.dll, which is included in this distribution. Put emx.dll into a
directory which is pointed to by the LIBPATH environment variable, or add the
directory in which you choose to store emx.dll to LIBPATH. If you already
have a version of file emx.dll, try your existing emx.dll first. If problems
arise, try the one included in this distribution.
* termcap.dat *
Ispell uses termcap for performing terminal i/o. The file termcap.dat
(included in this distribution) contains the terminal descriptions used by
termcap. You may:
1) put termcap.dat in the "current" working directory
2) put termcap.dat in the directory \emx\etc on the "current" drive
3) put termcap.dat in a directory pointed to by the INIT or
EMXETC environment variables
4) Set the environment variable TERMCAP to point to the location of
termcap.dat.
I strongly recommend option 4.
You may also set the environment variable TERM to select one of the terminal
types in termcap.dat. The terminal names are case sensitive, so type them
exactly as they are found in termcap.dat when setting TERM. If TERM is not
set, the terminal type defaults to 'ansi'. You can play around with the
settings in termcap.dat to obtain the color combinations that suit you. You
must have the device driver ansi.sys loaded to use Ispell. If you do not
already have ansi.sys loaded, see the OS/2 online help for information on
adding the device driver ansi.sys. You must reboot your computer if you are
adding ansi.sys
example: "SET TERM=ansi-color-2" selects the 'ansi-color-2' terminal type in
termcap.dat
Currently, Ispell does not automatically detect screen size; you will have to
set these values in the appropriate termcap.dat entry.
* ispell.cfg *
Ispell was originally written for Unix systems, and the program has many
compile-time options that are used to customize Ispell for the particular Unix
system it is being installed on. These options are set by the system
administrator before making the executable files. Since it is impossible
to know how users wish to install Ispell on their personal computers, I have
added a configuration file that allows users to set some of the options that
are "hard-wired" on Unix systems.
Ispell.cfg is a file that contains information about files that will be needed
by Ispell during the spelling of documents. Currently, 3 keywords are valid in
ispell.cfg (hopefully, I will be able to increase the configurability of
Ispell and add more keywords). The keywords are:
ISDEFPDICT Should contain the complete pathname of the
user's personal dictionary. This setting can be
overridden by the -p command line switch.
ISDEFHASH Should contain the pathname of the default hashed
dictionary. This setting can be overridden by the -d
command line switch.
ISTEMPFILE Should contain the pathname template for the temporary
files. The base filename must contain the characters
'XXXXXX'. Thus, if the temporary files are on a FAT
drive, the base filename may contain only 2 additional
characters. 'x:/ddddd/isXXXXXX.tmp' would be a valid
FAT setting. HPFS filenames may be longer.
The format for setting the keywords is:
keyword=any_valid_filename # optional comment
The line, including comments, can be no longer than 240 characters. The
filename may contain drive specifiers as well as directories. YOU MUST USE
FORWARD SLASHES (/) AS DIRECTORY SEPARATORS. Ispell.cfg may contain comments.
Any text between a '#' and the end of line will be treated as a comment.
Ispell will print out any invalid lines in ispell.cfg and abort. Please make
sure all settings in ispell.cfg conform to your particular file system (FAT or
HPFS). Currently, ispell.cfg is required. If a configuration file is not
found, Ispell will abort.
* hashed dictionaries *
This port of ispell requires a main hashed dictionary and an optional
personal word list. In order to use Ispell, you must create the main hashed
dictionary from the raw word list and the affix file for the particular
language you are using. The hashed dictionary is much larger than the
word list, but allows Ispell to work faster when spelling documents. Because
the hashed dictionaries are very large, this distribution includes the
word lists and a small program that creates the hashed dictionaries from the
word lists and affix file.
Briefly, the main word list contains root words followed by flags which
specify how and which suffixes and prefixes can be added to the word. The
affix file gives the rules on how these flags are to be interpreted. To build
a hashed dictionary for Ispell from the files included in this distribution,
type:
x:> buildhas english.med english.aff engmed.hash
and/or
x:> buildhas english.sml english.aff engsml.hash
and/or
x:> buildhas english.lrg english.aff englrg.hash
This will create the hashed dictionaries engmed.hash and/or engsml.hash and/or
englrg.hash. Assign the name of one of the dictionaries to the ISDEFHASH
keyword in ispell.cfg. If you are on a FAT drive, you must name the output
hashed dictionary appropriately, ie. engmed.has. You can give the hashed
dictionaries any names you wish. Remember to set ISDEFHASH so that it reflects
the name of your hashed dictionary.
I have included three raw word lists: english.sml, english.med, and
english.lrg, along with the affix files english.aff and german.aff.
English.lrg is known to contain errors, so beware.
The word lists english.sml, english.med and english.lrg are composed of
several component word lists. These component word lists contain the base
word list as well as alternate American and British spellings. The component
word lists are copied together and sorted into alphabetical order to form the
main word list. The original Makefile is set up to automate this procedure on
a Unix host, which is where I built the included word list . I have (will)
also uploaded all the source code and component word list in another archive.
If you wish to rebuild the main word lists, you can unpack the source code
archive and look at the makefile to figure out how it is done. English.sml and
english.med have undergone quite extensive testing.
I currently don't have any non-english word lists. There is a German affix
file, german.aff, but that is all that comes with the original distribution.
* personal word lists*
Ispell will automatically create a personal word list your under the name
specified by the keyword ISDEFPDICT in ispell.cfg. Ispell creates a hash
table for your personal dictionary during execution, so you do not need to
create a hashed dictionary from your personal word list. You may edit the
personal word list and add flags to the words if you wish. The flags are
explained in english4.doc and ispell4.doc.
This should complete the installation of Ispell. If you have made any changes
to config.sys, you should shutdown OS/2 and reboot your computer.
***** OTHER INFORMATION *****
* man pages *
ASCII text versions of the Ispell Unix man pages are included. These man
pages have been edited to reflect the changes made in this port of Ispell.
* FAT compatibility *
Since Ispell is originally a Unix program, it can use filenames beyond the 8.3
format allowed on an FAT systems. I have attempted to make this program FAT
compatible. All hard-wired default filenames have been changed to be FAT
compatible.
* Ispell utilities *
This is not a complete port of Ispell. The Unix shell scripts munchlist,
findaffix, and tryaffix. Munchlist is a raw dictionary maintenance utility
while findaffix and tryaffix are used for developing language affix files.
According to the original author, these shell scripts are very taxing on
system resources (mainly temporary file space) and require several Unix system
utilities that OS/2 users may not have. Also, the original author is
considering converting these scripts to C at a later date. For these reasons,
I have decided not to port the shell scripts at this time.
* emacs support *
The file ispell.el is included for emacs users. I don't use emacs so the emacs
support hasn't been tested under OS/2.
* warranty *
No warranty, express or implied is given for this software and documentation.
No guarantee is made as to the proper functioning of this software. No
liability will be admitted for any damage resulting from the use of any
programs or files contained in this distribution.
* bugs *
Send bug reports, errors in documentation, and suggestions to Joe Huber,
jbhuber@iastate.edu.